Repository navigation
docs: reconcile audited design and implementation drift - #2629
Merged
codeforester merged 3 commits intoNov 5, 2026
Merged
codeforester merged 3 commits into
codeforester merged 3 commits into
Conversation
This was referenced Oct 21, 2026
This was referenced Nov 5, 2026
codeforester
deleted the
documentation/2628-20261021-reconcile-audited-documentation-drift
branch
November 5, 2026 14:44
codeforester
added a commit
that referenced
this pull request
Nov 5, 2026
## Summary Users lack one reliable upgrade procedure across Homebrew, mutable source checkouts, and stable source tags. Add a canonical upgrade matrix and recovery guide, then link installation, shell, FAQ, command, and agent guidance to it. The guide distinguishes current-main behavior from v1.10.5: `update --release` and reconciliation after an unchanged Homebrew version were added later. It covers older-version fallback, direct package-manager/Git operations, active-install selection, setup failures after a ref change, runtime verification, and trust re-review. ## Issue Fixes #2597 Related audit corrections are in #2629 / #2628. This PR can be reviewed independently; both are documentation-only and target main. ## Validation - Existing documentation, local-link, contract-hardening, command-reference, and version checks: 80 pytest cases passed. - `bats cli/bash/commands/basectl/tests/update.bats`: all 28 cases passed, covering stable-tag upgrade/refusal/recovery, Homebrew reconciliation including unchanged versions, and mutable/project update behavior. - All 50 local heading links across changed documents resolved. After linking the upgrade contract into the registry, reran contract hardening and documentation links: 15 passed. - Compared the matrix and failure procedures against `update.sh`; `git diff --check` passed. - No real Homebrew upgrade, source upgrade, setup, or trust mutation was performed. ## Design Impact Documents the implemented update routes and their boundaries. No runtime changes, automatic trust approval, downgrade capability, or new release-verification guarantee is introduced. Remote tag matching is explicitly distinguished from immutable release/BOM evidence. ## Docs Impact `docs/upgrading.md` is the canonical upgrade procedure. README, FAQ, documentation index, bootstrap recipes, shell-startup guidance, Homebrew rehearsal, command reference, and `skills.md` now point to it. Duplicate upgrade procedures were consolidated to reduce synchronization risk. The contract registry links the guide to existing update behavior tests while preserving the need for prose review. ## AI Context Impact Add the route-specific update summary and canonical guide reference to `.ai-context/COMMANDS.md`. ## Release Notes Add the missing Unreleased notes for stable-source `--release` support and unconditional Homebrew runtime reconciliation. Published release sections remain unchanged. ## Demo Impact None. Existing command and demo behavior is unchanged; upgrade verification and the distinction between Base and consumer-project tests are documented. ## Review follow-up - The README's Homebrew upgrade link now points to the canonical upgrade guide; the install recipe remains the new-install entry point. - Updated the AI command context and its help-output assertion for the stable-source `--release <tag>` behavior. - Added `--release <tag>` and the guide link to the `basectl update` row in the technical overview. For this follow-up revision, `git diff --check` passed. The broader local test results above were collected before these final edits; hosted checks for the current head are running.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Several maintained guides describe older behavior even though the corresponding runtime changes are implemented and tested. Reconcile the audited contracts across design, user/reference docs, contributor guidance, and AI context without changing runtime code.
test.requirementsin the project-runtime decision table and make IDE mutation consent explicit.Issue
Fixes #2628
Refs #1611 and #1613 for broader runtime separation and the future input schema; neither is implemented or closed by this PR.
Validation
git diff --checkpassed. No real install, release publication, or uninstall was performed.Design Impact
Reconciles descriptions of implemented behavior. Release recovery follows the accepted #2551 contract. Uninstall explicitly retains the existing removal/retention behavior and describes its verification limits. No new runtime behavior or documentation-governance gate is introduced.
Docs Impact
Canonical runtime, IDE, release, workspace, ownership, and review documents now agree with the implementation. A dedicated uninstall guide is linked from the index, command reference, stability contract, cache layout, and adopter guide. Contributor guidance distinguishes Base-owned Python packages from the external framework and the legacy CI search-path entry. The contract registry maps reconciled behavior to implementation/tests and states the remaining semantic-coverage limits.
AI Context Impact
Update ARCHITECTURE, COMMANDS, and STATUS for runtime triggers, isolated wrapper execution, and static versus explicitly executing requirements inspection.
Release Notes
Unreleased now records the activation discovery repair from #2611. Documentation corrections do not change published release contents. The two missing upgrade notes belong to #2597's PR.
Demo Impact
None. This PR changes documentation only and preserves existing runtime/demo behavior.
Review follow-up
review_policymapping and clarified that the manifest example is representative rather than exhaustive.cli/pythonandlib/python; the repository currently has no tracked Base package underlib/python.For this follow-up revision,
git diff --checkpassed. The broader local test results above were collected before these final prose edits; all hosted checks for this head have passed.